/*!	 layer_bitmap.h
**	 Template Header
**
**	Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
**	Copyright (c) 2012-2013 Carlos López
**
**	This package is free software; you can redistribute it and/or
**	modify it under the terms of the GNU General Public License as
**	published by the Free Software Foundation; either version 2 of
**	the License, or (at your option) any later version.
**
**	This package is distributed in the hope that it will be useful,
**	but WITHOUT ANY WARRANTY; without even the implied warranty of
**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
**	General Public License for more details.
**
*/

#ifndef __SYNFIG_LAYER_BITMAP_H
#define __SYNFIG_LAYER_BITMAP_H

#include "layer_composite.h"
#include <synfig/surface.h>
#include <synfig/guid.h>
#include <synfig/target.h> // for RenderMethod

#include <synfig/rendering/surface.h>
#include <synfig/rendering/software/function/packedsurface.h>

namespace synfig
{

/*!	\class Layer_Bitmap
**	TODO:  writeme
*/
class Layer_Bitmap : public Layer_Composite, public Layer_NoDeform
{
    const Color& filter(Color& c)const;
    const CairoColor& filter(CairoColor& c)const;
    RenderMethod method;

    GUID surface_modification_id;
public:
    typedef etl::handle<Layer_Bitmap> Handle;

    ValueBase param_tl;
    ValueBase param_br;
    ValueBase param_c;
    ValueBase param_gamma_adjust;

    mutable synfig::Mutex mutex;
    mutable rendering::software::PackedSurface::Reader reader;
    mutable rendering::Surface::Handle rendering_surface;
    mutable bool trimmed;
    mutable unsigned int width, height, top, left;

    Layer_Bitmap();

    synfig::Surface& get_surface() const;

    GUID get_surface_modification_id() const
    {
        return surface_modification_id;
    }
    bool is_surface_modified() const
    {
        return (bool)get_surface_modification_id();
    }
    void add_surface_modification_id(const GUID &modification_id)
    {
        surface_modification_id ^= modification_id;
    }
    void reset_surface_modification_id()
    {
        surface_modification_id = GUID::zero();
    }

    virtual bool set_param(const String & param, const ValueBase & value);

    virtual ValueBase get_param(const String & param)const;

    virtual Color get_color(Context context, const Point &pos)const;
    virtual CairoColor get_cairocolor(Context context, const Point &pos)const;

    virtual Vocab get_param_vocab()const;

    virtual Rect get_bounding_rect()const;

    virtual bool accelerated_render(Context context, Surface *surface, int quality, const RendDesc &renddesc, ProgressCallback *cb)const;
    virtual bool accelerated_cairorender(Context context, cairo_t *cr, int quality, const RendDesc &renddesc, ProgressCallback *cb)const;

    virtual synfig::Layer::Handle hit_check(synfig::Context context, const synfig::Point &point)const;

    virtual void set_render_method(Context context, RenderMethod x);
    void set_method(RenderMethod x)
    {
        method = x;
    }
    RenderMethod get_method()const
    {
        return method;
    }

protected:
    virtual rendering::Task::Handle build_composite_task_vfunc(ContextParams context_params)const;
}; // END of class Layer_Bitmap

}; // END of namespace synfig

#endif